<?php
/**
 * Ruth Library
 * $Id: Trim.php 2 2008-01-17 02:59:56Z baron314159@yahoo.com $
 *
 * LICENSE
 *
 * Copyright (c) 2007, Chris Utz
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Impact Lab nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY CHRIS UTZ ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL CHRIS UTZ BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @category   Ruth
 * @package    Ruth_Filter
 * @author     Chris Utz <chris@chrisutz.com>
 * @copyright  2007 Chris Utz <chris@chrisutz.com>
 * @license    http://www.opensource.org/licenses/bsd-license.php    New BSD License
 * @version    $Revision: 2 $
 */

/**
 * @see Ruth_Filter_Abstract
 */
require_once 'Ruth/Filter/Abstract.php';

/** 
 * @see Ruth_Filter_Exception
 */
require_once 'Ruth/Filter/Exception.php';

/**
 * Trims the input value using character list set in options and on
 * the specified sides.
 *
 * @category   Ruth
 * @package    Ruth_Filter
 * @author     Chris Utz <chris@chrisutz.com>
 * @copyright  2007 Chris Utz <chris@chrisutz.com>
 * @license    http://www.opensource.org/licenses/bsd-license.php    New BSD License
 * @version    $Revision: 2 $
 */
class Ruth_Filter_Trim extends Ruth_Filter_Abstract
{
    /**
     * @param string $value
     * @return string
     * @throws Ruth_Filter_Exception if an invalid sides option is specified
     */
    public function filter($value)
    {
        $value = (string) $value;

        switch ($this->_options->get('sides', 'rl')) {
            case 'l':
                if ($this->_options->charList) {
                    return ltrim($value, $this->_options->charList);
                } else {
                    return ltrim($value);
                }
                break;
            case 'r':
                if ($this->_options->charList) {
                    return rtrim($value, $this->_options->charList);
                } else {
                    return rtrim($value);
                }
                break;
            case 'lr':
            case 'rl':
                if ($this->_options->charList) {
                    return trim($value, $this->_options->charList);
                } else {
                    return trim($value);
                }
                break;
            default:
                throw new Ruth_Filter_Exception("invalid sides option specified");
        }
    }
}
 
// vim: sw=4:ts=4:sts=4:et
